Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
IpsProcess Class Reference

IpsProcess is the process that handles intrusion prevention. More...

Inheritance diagram for IpsProcess:
Process

Public Member Functions

void setConfigLocation (string)
 Sets the directory location. More...
 
string getConfigLocation ()
 Returns the config location directory for IPS. More...
 
string getIpsAt (int)
 Returns the IPS at the specified index. More...
 
string getAclForIps (string)
 Returns the ACL for the IPS with the specified name. More...
 
void addIps (string, string)
 Adds an IPS with the specified name and ACL. More...
 
bool deleteIps (string)
 Removes the IPS from the list. More...
 
int getIpsListSize ()
 Returns the number of IPS configured. More...
 
SignatureCategory getRootSigCategory ()
 Returns the root signature category category. More...
 
Category getSubCategoryAt (int)
 Returns the subcategory at the specified index. More...
 
int getSubCategorySize ()
 Returns the subcategory size. More...
 
IcmpSignature getIcmpSignature ()
 Returns the ICMP signature. More...
 
void setRetryCount (int)
 Sets the retry count. More...
 
int getRetryCount ()
 Returns the retry count. More...
 
void setNotifyLog (bool)
 Sets the syslog notification. More...
 
bool isSysLogEnabled ()
 Returns true if syslog is enabled, otherwise false. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

IpsProcess is the process that handles intrusion prevention.

Member Function Documentation

◆ addIps()

void IpsProcess::addIps ( string  ,
string   
)

Adds an IPS with the specified name and ACL.

Parameters
ipsName,thename of this IPS.
aclName,thename of the ACL for this IPS.

◆ deleteIps()

bool IpsProcess::deleteIps ( string  )

Removes the IPS from the list.

Parameters
ipsName,thename of the IPS of interest.
Returns
bool, true if successful, otherwise false.

◆ getAclForIps()

string IpsProcess::getAclForIps ( string  )

Returns the ACL for the IPS with the specified name.

Parameters
ipsName,thename of the IPS of interest.
Returns
string, the ACL for the IPS with the specified name.

◆ getConfigLocation()

string IpsProcess::getConfigLocation ( )

Returns the config location directory for IPS.

Returns
string, the config location directory for IPS.

◆ getIcmpSignature()

IcmpSignature IpsProcess::getIcmpSignature ( )

Returns the ICMP signature.

Returns
IcmpSignature, the IcmpSignature object.

◆ getIpsAt()

string IpsProcess::getIpsAt ( int  )

Returns the IPS at the specified index.

Parameters
index,theindex of the IPS of interest.
Returns
string, the IPS at the specified index.

◆ getIpsListSize()

int IpsProcess::getIpsListSize ( )

Returns the number of IPS configured.

Returns
int, the number of IPS configured.

◆ getRetryCount()

int IpsProcess::getRetryCount ( )

Returns the retry count.

Returns
int, the retry count.

◆ getRootSigCategory()

SignatureCategory IpsProcess::getRootSigCategory ( )

Returns the root signature category category.

Returns
SignatureCategory, the SignatureCategory object.

◆ getSubCategoryAt()

Category IpsProcess::getSubCategoryAt ( int  )

Returns the subcategory at the specified index.

Parameters
index,theindex of the subcategory of interest.
Returns
Category, the Category object at the specified index.

◆ getSubCategorySize()

int IpsProcess::getSubCategorySize ( )

Returns the subcategory size.

Returns
int, the subcategory size.

◆ isSysLogEnabled()

bool IpsProcess::isSysLogEnabled ( )

Returns true if syslog is enabled, otherwise false.

Returns
bool, true if syslog is enabled, otherwise false.

◆ setConfigLocation()

void IpsProcess::setConfigLocation ( string  )

Sets the directory location.

Parameters
name,thedirectory location.

◆ setNotifyLog()

void IpsProcess::setNotifyLog ( bool  )

Sets the syslog notification.

Parameters
val,trueto enable syslog, false to disable it.

◆ setRetryCount()

void IpsProcess::setRetryCount ( int  )

Sets the retry count.

Parameters
count,theretry count.

The documentation for this class was generated from the following file: